FoxitPDFSDKPython3.Redact类 参考
类 FoxitPDFSDKPython3.Redact 继承关系图:
Public 成员函数 | |
| def | Redact () |
| 构造函数。 | |
| def | Redact (annot) |
| 构造函数，使用父类对象。 更多... | |
| def | Apply () |
| 应用当前编辑注释：永久移除注释矩形下的文本、图形和注释。 更多... | |
| def | EnableAutoFontSize () |
| 为覆盖文本启用自动字体大小。 更多... | |
| def | EnableRepeatOverlayText (is_to_repeat_overlay_text) |
| 设置标志以决定是否重复覆盖文本。 更多... | |
| def | GetApplyFillColor () |
| 获取用于翻转外观的填充颜色，将在应用编辑后使用。 更多... | |
| def | GetDefaultAppearance () |
| 获取默认外观数据。 更多... | |
| def | GetFillColor () |
| 获取填充颜色。 更多... | |
| def | GetOverlayText () |
| 获取覆盖文本。 更多... | |
| def | GetOverlayTextAlignment () |
| 获取覆盖文本的对齐值。 更多... | |
| def | GetQuadPoints () |
| 获取四边形。 更多... | |
| def | IsOverlayTextRepeated () |
| 检查覆盖文本是否重复。 更多... | |
| def | SetApplyFillColor (fill_color) |
| 设置用于翻转外观的填充颜色，将在应用编辑后使用。 更多... | |
| def | SetDefaultAppearance (default_ap) |
| 设置默认外观数据。 更多... | |
| def | SetFillColor (fill_color) |
| 设置填充颜色。 更多... | |
| def | SetOverlayText (overlay_text) |
| 设置覆盖文本。 更多... | |
| def | SetOverlayTextAlignment (alignment) |
| 设置覆盖文本的对齐值。 更多... | |
| def | SetQuadPoints (quad_points_array) |
| 设置四边形。 更多... | |
 Public 成员函数 继承自 FoxitPDFSDKPython3.Markup | |
| def | Markup () |
| 构造函数 | |
| def | AddReply () |
| 在回复列表的末尾添加新回复。 更多... | |
| def | AddRichText (content, style) |
| 在末尾添加新的富文本字符串。 更多... | |
| def | AddStateAnnot (title, model, state) |
| 添加新的状态注释。 更多... | |
| def | GetBorderOpacity () |
| 获取注释的边框透明度。 更多... | |
| def | GetCreationDateTime () |
| 获取创建日期时间。 更多... | |
| def | GetFillOpacity () |
| 获取注释的填充透明度。 更多... | |
| def | GetGroupElements () |
| 从当前标记注释所属的组中获取一个元素（作为标记注释）。 更多... | |
| def | GetGroupHeader () |
| 获取当前标记注释所属组的头注释（作为主注释）。 更多... | |
| def | GetIntent () |
| 获取意图名称。 更多... | |
| def | GetOpacity () |
| 获取不透明度值。 更多... | |
| def | GetPopup () |
| 获取相关的弹出注释。 更多... | |
| def | GetReply (index) |
| 按索引获取回复。 更多... | |
| def | GetReplyCount () |
| 计算所有回复。 更多... | |
| def | GetRichTextContent (index) |
| 获取指定索引的富文本字符串的文本字符串。 更多... | |
| def | GetRichTextCount () |
| 获取富文本字符串的数量。 更多... | |
| def | GetRichTextStyle (index) |
| 获取指定索引的富文本字符串的样式数据。 更多... | |
| def | GetStateAnnots (model) |
| 获取指定状态模型中的所有状态注释。 更多... | |
| def | GetSubject () |
| 获取主题字符串。 更多... | |
| def | GetTitle () |
| 获取标题字符串。 更多... | |
| def | InsertRichText (index, content, style) |
| 在指定索引位置插入新的富文本字符串。 更多... | |
| def | IsGrouped () |
| 检查当前标记注释是否在组中。 更多... | |
| def | RemoveAllReplies () |
| 删除所有回复。 更多... | |
| def | RemoveAllStateAnnots () |
| 移除所有状态注释。 更多... | |
| def | RemovePopup () |
| 删除相关的弹出注释。 更多... | |
| def | RemoveReply (index) |
| 按索引删除回复。 更多... | |
| def | RemoveRichText (index) |
| 移除指定索引的富文本字符串。 更多... | |
| def | SetBorderOpacity (opacity) |
| 设置注释的边框透明度。 更多... | |
| def | SetCreationDateTime (date_time) |
| 设置创建日期时间。 更多... | |
| def | SetFillOpacity (opacity) |
| 设置注释的填充透明度。 更多... | |
| def | SetIntent (intent) |
| 设置意图名称。 更多... | |
| def | SetOpacity (opacity) |
| 设置不透明度值。 更多... | |
| def | SetPopup (popup) |
| 设置相关的弹出注释。 更多... | |
| def | SetRichTextContent (index, content) |
| 设置指定索引的富文本字符串的文本字符串。 更多... | |
| def | SetRichTextStyle (index, style) |
| 设置指定索引的富文本字符串的样式数据。 更多... | |
| def | SetSubject (subject) |
| 设置主题字符串。 更多... | |
| def | SetTitle (title) |
| 设置标题字符串。 更多... | |
| def | Ungroup () |
| 将当前标记注释从其所属的组中解组。 更多... | |
| Public 成员函数 继承自 FoxitPDFSDKPython3.Annot | |
| def | Annot () |
| 构造函数。 | |
| def | Annot (annot) |
| 构造函数，使用另一个注释对象。 更多... | |
| def | GetAppearanceStream (type, appearance_state) |
| 获取具有指定类型和状态的注释外观流。 更多... | |
| def | GetBorderColor () |
| 获取边框颜色。 更多... | |
| def | GetBorderInfo () |
| 获取边框信息。 更多... | |
| def | GetContent () |
| 获取内容。 更多... | |
| def | GetDeviceRect (matrix) |
| 获取设备坐标系统中的注释矩形。 更多... | |
| def | GetDict () |
| 获取注释的字典对象。 更多... | |
| def | GetDisplayMatrix (page_display_matrix) |
| 获取显示矩阵，从到 目标设备坐标系统。 更多... | |
| def | GetFlags () |
| 获取注释标志。 更多... | |
| def | GetIndex () |
| 获取当前注释在其所属页面中的索引。 更多... | |
| def | GetModifiedDateTime () |
| 获取最后修改日期时间。 更多... | |
| def | GetOptionalContent () |
| 获取注释可选内容的PDF字典。 更多... | |
| def | GetPage () |
| 获取相关的PDF页面。 更多... | |
| def | GetRect () |
| 获取矩形，以表示。 更多... | |
| def | GetType () |
| 获取当前注释的实际注释类型。 更多... | |
| def | GetUniqueID () |
| 获取唯一ID。 更多... | |
| def | HasProperty (property) |
| 当前注释是否具有指定的注释属性。 更多... | |
| def | IsEmpty () |
| 检查当前对象是否为空。 更多... | |
| def | IsMarkup () |
| 检查当前注释是否为标记注释。 更多... | |
| def | Move (rect) |
| 将当前注释移动到新位置，由中的新矩形指定。 更多... | |
| def | Move (rect, is_reset_appearance) |
| 将当前注释移动到新位置，由中的新矩形指定。 更多... | |
| def | RemoveProperty (property) |
| 删除指定的注释属性。 更多... | |
| def | ResetAppearanceStream () |
| 重置外观流。 更多... | |
| def | SetBorderColor (color) |
| 设置边框颜色。 更多... | |
| def | SetBorderInfo (border) |
| 设置边框信息。 更多... | |
| def | SetContent (content) |
| 设置内容。 更多... | |
| def | SetFlags (flags) |
| 设置注释标志。 更多... | |
| def | SetModifiedDateTime (date_time) |
| 设置最后修改日期时间。 更多... | |
| def | SetUniqueID (unique_id) |
| 设置唯一ID。 更多... | |
额外继承的成员函数 | |
| 静态 Public 属性 继承自 FoxitPDFSDKPython3.Markup | |
| e_EndingStyleButt = _fsdk.Markup_e_EndingStyleButt | |
| 端点处垂直于线条本身的短线。 | |
| e_EndingStyleCircle = _fsdk.Markup_e_EndingStyleCircle | |
| 用注释的内部颜色填充的圆形（如果有）。 | |
| e_EndingStyleClosedArrow = _fsdk.Markup_e_EndingStyleClosedArrow | |
| 两条短线以锐角相交（如OpenArrow样式），并由第三条线连接， 形成用注释的内部颜色填充的三角形闭合箭头（如果有）。 | |
| e_EndingStyleDiamond = _fsdk.Markup_e_EndingStyleDiamond | |
| 用注释的内部颜色填充的菱形（如果有）。 | |
| e_EndingStyleNone = _fsdk.Markup_e_EndingStyleNone | |
| 无特殊线条端点。 | |
| e_EndingStyleOpenArrow = _fsdk.Markup_e_EndingStyleOpenArrow | |
| 两条短线以锐角相交形成开放箭头。 | |
| e_EndingStyleRClosedArrow = _fsdk.Markup_e_EndingStyleRClosedArrow | |
| 与ClosedArrow方向相反的三角形闭合箭头。 | |
| e_EndingStyleROpenArrow = _fsdk.Markup_e_EndingStyleROpenArrow | |
| 与OpenArrow方向相反的两条短线。 | |
| e_EndingStyleSlash = _fsdk.Markup_e_EndingStyleSlash | |
| 端点处与线条垂直方向约顺时针30度的短线。 | |
| e_EndingStyleSquare = _fsdk.Markup_e_EndingStyleSquare | |
| 用注释的内部颜色填充的正方形（如果有）。 | |
| e_MeasureTypeA = _fsdk.Markup_e_MeasureTypeA | |
| 面积的测量。 | |
| e_MeasureTypeD = _fsdk.Markup_e_MeasureTypeD | |
| 任意方向距离的测量。 | |
| e_MeasureTypeS = _fsdk.Markup_e_MeasureTypeS | |
| 直线斜率的测量。 | |
| e_MeasureTypeT = _fsdk.Markup_e_MeasureTypeT | |
| 角度的测量。 | |
| e_MeasureTypeX = _fsdk.Markup_e_MeasureTypeX | |
| 沿x轴变化的测量。 | |
| e_MeasureTypeY = _fsdk.Markup_e_MeasureTypeY | |
| 沿y轴变化的测量。 | |
| e_StateAccepted = _fsdk.Markup_e_StateAccepted | |
| （与状态模型FoxitPDFSDKPython3.Markup.e_StateModelReview 一起使用） 用户同意更改。 | |
| e_StateCancelled = _fsdk.Markup_e_StateCancelled | |
| （与状态模型FoxitPDFSDKPython3.Markup.e_StateModelReview 一起使用） 更改已被取消。 | |
| e_StateCompleted = _fsdk.Markup_e_StateCompleted | |
| （与状态模型FoxitPDFSDKPython3.Markup.e_StateModelReview 一起使用） 更改已完成。 | |
| e_StateDeferred = _fsdk.Markup_e_StateDeferred | |
| （与状态模型FoxitPDFSDKPython3.Markup.e_StateModelReview 一起使用） 更改已延期。 | |
| e_StateFuture = _fsdk.Markup_e_StateFuture | |
| （与状态模型FoxitPDFSDKPython3.Markup.e_StateModelReview 一起使用） 更改将在将来进行。 | |
| e_StateMarked = _fsdk.Markup_e_StateMarked | |
| （与状态模型FoxitPDFSDKPython3.Markup.e_StateModelMarked 一起使用） 注释已被用户标记。 | |
| e_StateModelMarked = _fsdk.Markup_e_StateModelMarked | |
| 标记注释状态模型：已标记。 | |
| e_StateModelReview = _fsdk.Markup_e_StateModelReview | |
| 标记注释状态模型：审阅。 | |
| e_StateNone = _fsdk.Markup_e_StateNone | |
| （与状态模型FoxitPDFSDKPython3.Markup.e_StateModelReview 一起使用） 用户没有对更改表示任何意见。 | |
| e_StateRejected = _fsdk.Markup_e_StateRejected | |
| （与状态模型FoxitPDFSDKPython3.Markup.e_StateModelReview 一起使用） 用户不同意更改。 | |
| e_StateUnmarked = _fsdk.Markup_e_StateUnmarked | |
| （与状态模型FoxitPDFSDKPython3.Markup.e_StateModelMarked 一起使用） 注释尚未被用户标记。 | |
| 静态 Public 属性 继承自 FoxitPDFSDKPython3.Annot | |
| e_3D = _fsdk.Annot_e_3D | |
| 注释类型：3D注释。<PDF参考1.7>中的标准注释之一。 | |
| e_AppearanceTypeDown = _fsdk.Annot_e_AppearanceTypeDown | |
| 注释的按下外观。 | |
| e_AppearanceTypeNormal = _fsdk.Annot_e_AppearanceTypeNormal | |
| 注释的正常外观。 | |
| e_AppearanceTypeRollover = _fsdk.Annot_e_AppearanceTypeRollover | |
| 注释的悬停外观。 | |
| e_Caret = _fsdk.Annot_e_Caret | |
| 注释类型：插入符注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Circle = _fsdk.Annot_e_Circle | |
| 注释类型：圆形注释。<PDF参考1.7>中的标准注释之一。 | |
| e_FileAttachment = _fsdk.Annot_e_FileAttachment | |
| 注释类型：文件附件注释。<PDF参考1.7>中的标准注释之一。 | |
| e_FlagHidden = _fsdk.Annot_e_FlagHidden | |
| 注释标志：隐藏。 更多... | |
| e_FlagInvisible = _fsdk.Annot_e_FlagInvisible | |
| 注释标志：不可见。 更多... | |
| e_FlagLocked = _fsdk.Annot_e_FlagLocked | |
| 注释标志：锁定。 更多... | |
| e_FlagLockedContents = _fsdk.Annot_e_FlagLockedContents | |
| 注释标志：锁定内容。 更多... | |
| e_FlagNoRotate = _fsdk.Annot_e_FlagNoRotate | |
| 注释标志：无旋转。 更多... | |
| e_FlagNoView = _fsdk.Annot_e_FlagNoView | |
| 注释标志：无视图。 更多... | |
| e_FlagNoZoom = _fsdk.Annot_e_FlagNoZoom | |
| 注释标志：无缩放。 更多... | |
| e_FlagPrint = _fsdk.Annot_e_FlagPrint | |
| 注释标志：打印。 更多... | |
| e_FlagReadOnly = _fsdk.Annot_e_FlagReadOnly | |
| 注释标志：只读。 更多... | |
| e_FlagToggleNoView = _fsdk.Annot_e_FlagToggleNoView | |
| 注释标志：切换无视图。 更多... | |
| e_FreeText = _fsdk.Annot_e_FreeText | |
| 注释类型：自由文本注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Highlight = _fsdk.Annot_e_Highlight | |
| 注释类型：高亮注释。<PDF参考1.7>中的标准注释之一。 | |
| e_HighlightingInvert = _fsdk.Annot_e_HighlightingInvert | |
| 高亮模式：反转，即反转注释矩形的内容。 | |
| e_HighlightingNone = _fsdk.Annot_e_HighlightingNone | |
| 高亮模式：无高亮。 | |
| e_HighlightingOutline = _fsdk.Annot_e_HighlightingOutline | |
| 高亮模式：轮廓，即反转注释的边框。 | |
| e_HighlightingPush = _fsdk.Annot_e_HighlightingPush | |
| 高亮模式：按下，即显示注释的按下外观（如果有）。 | |
| e_HighlightingToggle = _fsdk.Annot_e_HighlightingToggle | |
| 高亮模式：切换。这仅对小组件注释有用。 | |
| e_Ink = _fsdk.Annot_e_Ink | |
| 注释类型：墨迹注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Line = _fsdk.Annot_e_Line | |
| 注释类型：直线注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Link = _fsdk.Annot_e_Link | |
| 注释类型：链接注释。<PDF参考1.7>中的标准注释之一。 | |
| e_MKEntryBackgroundColor = _fsdk.Annot_e_MKEntryBackgroundColor | |
| 背景颜色条目。MK字典中的"BG"。 | |
| e_MKEntryBorderColor = _fsdk.Annot_e_MKEntryBorderColor | |
| 边框颜色条目。MK字典中的"BC"。 | |
| e_MKEntryDownCaption = _fsdk.Annot_e_MKEntryDownCaption | |
| 按下标题（或备用标题）条目。MK字典中的"AC"。 更多... | |
| e_MKEntryDownIcon = _fsdk.Annot_e_MKEntryDownIcon | |
| 按下图标（或备用图标）条目。MK字典中的"IX"。 更多... | |
| e_MKEntryIconCaptionRelation = _fsdk.Annot_e_MKEntryIconCaptionRelation | |
| 图标和标题关系条目。MK字典中的"TP"。 更多... | |
| e_MKEntryIconFit = _fsdk.Annot_e_MKEntryIconFit | |
| 图标适配信息条目。MK字典中的"IF"。 更多... | |
| e_MKEntryNormalCaption = _fsdk.Annot_e_MKEntryNormalCaption | |
| 正常标题条目。MK字典中的"CA"。 更多... | |
| e_MKEntryNormalIcon = _fsdk.Annot_e_MKEntryNormalIcon | |
| 正常图标条目。MK字典中的"I"。 更多... | |
| e_MKEntryRolloverCaption = _fsdk.Annot_e_MKEntryRolloverCaption | |
| 悬停标题条目。MK字典中的"RC"。 更多... | |
| e_MKEntryRolloverIcon = _fsdk.Annot_e_MKEntryRolloverIcon | |
| 悬停图标条目。MK字典中的"RI"。 更多... | |
| e_MKEntryRotation = _fsdk.Annot_e_MKEntryRotation | |
| 旋转条目。MK字典中的"R"。 | |
| e_MKRelationCaptionAboveIcon = _fsdk.Annot_e_MKRelationCaptionAboveIcon | |
| 标题在图标上方。 | |
| e_MKRelationCaptionBelowIcon = _fsdk.Annot_e_MKRelationCaptionBelowIcon | |
| 标题在图标下方。 | |
| e_MKRelationCaptionLeft = _fsdk.Annot_e_MKRelationCaptionLeft | |
| 标题在图标左侧。 | |
| e_MKRelationCaptionOvrlayOnIcon = _fsdk.Annot_e_MKRelationCaptionOvrlayOnIcon | |
| 标题直接覆盖在图标上。 | |
| e_MKRelationCaptionRight = _fsdk.Annot_e_MKRelationCaptionRight | |
| 标题在图标右侧。 | |
| e_MKRelationNoCaption = _fsdk.Annot_e_MKRelationNoCaption | |
| 无标题；仅图标。 | |
| e_MKRelationNoIcon = _fsdk.Annot_e_MKRelationNoIcon | |
| 无图标；仅标题。 | |
| e_Movie = _fsdk.Annot_e_Movie | |
| 注释类型：电影注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Note = _fsdk.Annot_e_Note | |
| 注释类型：注记注释，即"文本"注释 - <PDF参考1.7>中的标准注释之一。 | |
| e_PagingSeal = _fsdk.Annot_e_PagingSeal | |
| 注释类型：分页印章注释。福昕PDF SDK自定义注释类型（非标准注释类型）。 | |
| e_Polygon = _fsdk.Annot_e_Polygon | |
| 注释类型：多边形注释。<PDF参考1.7>中的标准注释之一。 | |
| e_PolyLine = _fsdk.Annot_e_PolyLine | |
| 注释类型：折线注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Popup = _fsdk.Annot_e_Popup | |
| 注释类型：弹出注释。<PDF参考1.7>中的标准注释之一。 | |
| e_PrinterMark = _fsdk.Annot_e_PrinterMark | |
| 注释类型：印刷标记注释。<PDF参考1.7>中的标准注释之一。 | |
| e_PropertyBorderColor = _fsdk.Annot_e_PropertyBorderColor | |
| 注释属性：边框颜色。 更多... | |
| e_PropertyCreationDate = _fsdk.Annot_e_PropertyCreationDate | |
| 注释属性：创建日期。 更多... | |
| e_PropertyFillColor = _fsdk.Annot_e_PropertyFillColor | |
| 注释属性：填充颜色 更多... | |
| e_PropertyModifiedDate = _fsdk.Annot_e_PropertyModifiedDate | |
| 注释属性：修改日期。 | |
| e_PSInk = _fsdk.Annot_e_PSInk | |
| 注释类型：压力敏感墨迹注释。 | |
| e_Redact = _fsdk.Annot_e_Redact | |
| 注释类型：编辑注释。 | |
| e_RichMedia = _fsdk.Annot_e_RichMedia | |
| 注释类型：富媒体注释。 | |
| e_Screen = _fsdk.Annot_e_Screen | |
| 注释类型：屏幕注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Sound = _fsdk.Annot_e_Sound | |
| 注释类型：声音注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Square = _fsdk.Annot_e_Square | |
| 注释类型：矩形注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Squiggly = _fsdk.Annot_e_Squiggly | |
| 注释类型：波浪线注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Stamp = _fsdk.Annot_e_Stamp | |
| 注释类型：印章注释。<PDF参考1.7>中的标准注释之一。 | |
| e_StrikeOut = _fsdk.Annot_e_StrikeOut | |
| 注释类型：删除线注释。<PDF参考1.7>中的标准注释之一。 | |
| e_TrapNet = _fsdk.Annot_e_TrapNet | |
| 注释类型：陷阱网络注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Underline = _fsdk.Annot_e_Underline | |
| 注释类型：下划线注释。<PDF参考1.7>中的标准注释之一。 | |
| e_UnknownType = _fsdk.Annot_e_UnknownType | |
| 注释类型：未知。 | |
| e_Watermark = _fsdk.Annot_e_Watermark | |
| 注释类型：水印注释。<PDF参考1.7>中的标准注释之一。 | |
| e_Widget = _fsdk.Annot_e_Widget | |
| 注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。 更多... | |
详细描述
类Redact 表示福昕自定义注释类型（不是标准注释类型）。这种注释 用于标记PDF页面的一些内容，当编辑注释被应用时，这些内容将被移除。现有的编辑注释可以通过函数 FoxitPDFSDKPython3.PDFPage.GetAnnot 和FoxitPDFSDKPython3.PDFPage.GetAnnotAtPoint 从PDF页面获取。 新的编辑注释由函数FoxitPDFSDKPython3.Redaction.MarkRedactAnnot 返回，而不是FoxitPDFSDKPython3.PDFPage.AddAnnot 。
类FoxitPDFSDKPython3.Redact 派生自类Markup ，还提供获取/设置 编辑注释的标记注释基本属性的函数。 目前，FoxitPDFSDKPython3.Annot.SetBorderInfo 可以用于编辑注释，但不会 对编辑注释的外观产生任何影响。 此外，编辑注释不能通过函数FoxitPDFSDKPython3.Annot.Move 移动。
构造及析构函数说明
◆ Redact()
| def FoxitPDFSDKPython3.Redact.Redact | ( | annot | ) |
构造函数，使用父类对象。
- 参数
-
[in] annot 父类对象。
成员函数说明
◆ Apply()
| def FoxitPDFSDKPython3.Redact.Apply | ( | ) |
应用当前编辑注释：永久移除注释矩形下的文本、图形和注释。
一旦此函数成功调用，当前编辑注释矩形区域内的所有页面内容（文本对象、图像对象和路径对象） 和注释都将被永久移除。但是，如果其他编辑注释与当前编辑相交或包含在当前编辑内， 它们将不会被删除。对于当前编辑注释，它也将被移除（如果有弹出注释的话也一并移除）
-
这意味着当此函数成功时当前注释对象将变得无用。当前编辑注释矩形的区域将被 函数FoxitPDFSDKPython3.Redact.SetApplyFillColor 指定的颜色填充。
- 返回
- true表示成功，而false表示失败。
◆ EnableAutoFontSize()
| def FoxitPDFSDKPython3.Redact.EnableAutoFontSize | ( | ) |
为覆盖文本启用自动字体大小。
- 返回
- 无。
◆ EnableRepeatOverlayText()
| def FoxitPDFSDKPython3.Redact.EnableRepeatOverlayText | ( | is_to_repeat_overlay_text | ) |
设置标志以决定是否重复覆盖文本。
- 参数
-
[in] is_to_repeat_overlay_text true表示重复覆盖文本，而false表示不重复。 默认值：false。
- 返回
- 无。
◆ GetApplyFillColor()
| def FoxitPDFSDKPython3.Redact.GetApplyFillColor | ( | ) |
获取用于翻转外观的填充颜色，将在应用编辑后使用。
- 返回
- 填充颜色。格式：0xRRGGBB。 如果找不到填充颜色，将返回0xFFFFFF。
◆ GetDefaultAppearance()
| def FoxitPDFSDKPython3.Redact.GetDefaultAppearance | ( | ) |
获取默认外观数据。
此属性对编辑注释的外观有影响。默认外观数据可用于 格式化文本。
- 返回
- 默认外观数据。
◆ GetFillColor()
| def FoxitPDFSDKPython3.Redact.GetFillColor | ( | ) |
获取填充颜色。
- 返回
- 填充颜色。格式：0xRRGGBB。 如果找不到填充颜色，将返回0x000000。
◆ GetOverlayText()
| def FoxitPDFSDKPython3.Redact.GetOverlayText | ( | ) |
获取覆盖文本。
- 返回
- 覆盖文本字符串。
◆ GetOverlayTextAlignment()
| def FoxitPDFSDKPython3.Redact.GetOverlayTextAlignment | ( | ) |
◆ GetQuadPoints()
| def FoxitPDFSDKPython3.Redact.GetQuadPoints | ( | ) |
获取四边形。
四边形中点的顺序应该是：
-
第一个点是四边形左上角的点。
-
第二个点是四边形右上角的点。
-
第三个点是四边形左下角的点。
-
第四个点是四边形右下角的点。
- 返回
- 接收四边形值的四边形点数组。
◆ IsOverlayTextRepeated()
| def FoxitPDFSDKPython3.Redact.IsOverlayTextRepeated | ( | ) |
检查覆盖文本是否重复。
- 返回
- true表示覆盖文本重复，而false表示不重复。
◆ SetApplyFillColor()
| def FoxitPDFSDKPython3.Redact.SetApplyFillColor | ( | fill_color | ) |
设置用于翻转外观的填充颜色，将在应用编辑后使用。
- 参数
-
[in] fill_color 要设置的新填充颜色。格式：0xRRGGBB。
- 返回
- 无。
◆ SetDefaultAppearance()
| def FoxitPDFSDKPython3.Redact.SetDefaultAppearance | ( | default_ap | ) |
设置默认外观数据。
此属性对编辑注释的外观有影响。默认外观数据可用于 格式化文本。
如果用户希望新的默认外观数据对注释的外观产生影响， 请在设置新的默认外观数据后调用函数FoxitPDFSDKPython3.Annot.ResetAppearanceStream 。
- 参数
-
[in] default_ap 要设置的新默认外观数据。 输入数据的flags可用于决定哪些信息将 使用新数据更新；对于那些未更新的数据，它们将继续使用旧数据。
- 返回
- true表示成功，而false表示失败。 特别地，如果参数default_ap包含任何不正确的值，此函数将返回false， 例如：
-
输入数据的flags包含FoxitPDFSDKPython3.DefaultAppearance.e_FlagFont 但输入数据的font无效。
-
输入数据的flags包含FoxitPDFSDKPython3.DefaultAppearance.e_FlagFontSize 但输入数据的text size不大于零。
-
输入数据的flags包含FoxitPDFSDKPython3.DefaultAppearance.e_FlagFont 但输入数据的font无效。
◆ SetFillColor()
| def FoxitPDFSDKPython3.Redact.SetFillColor | ( | fill_color | ) |
设置填充颜色。
- 参数
-
[in] fill_color 要设置的新填充颜色。格式：0xRRGGBB。
- 返回
- 无。
◆ SetOverlayText()
| def FoxitPDFSDKPython3.Redact.SetOverlayText | ( | overlay_text | ) |
设置覆盖文本。
- 参数
-
[in] overlay_text 要设置的覆盖文本字符串。
- 返回
- 无。
◆ SetOverlayTextAlignment()
| def FoxitPDFSDKPython3.Redact.SetOverlayTextAlignment | ( | alignment | ) |
设置覆盖文本的对齐值。
此属性对编辑注释外观的覆盖文本有影响。如果用户希望新对齐对 注释外观的覆盖文本产生影响，请在设置新对齐后调用函数 FoxitPDFSDKPython3.Annot.ResetAppearanceStream 。
- 参数
-
[in] alignment 新的对齐值。请参考从FoxitPDFSDKPython3.e_AlignmentLeft 开始的值， 这应该是这些值中的一个。
- 返回
- 无。
◆ SetQuadPoints()
| def FoxitPDFSDKPython3.Redact.SetQuadPoints | ( | quad_points_array | ) |
设置四边形。
此属性对编辑注释的外观有影响。四边形中点的顺序应该是：
-
第一个点是四边形左上角的点。
-
第二个点是四边形右上角的点。
-
第三个点是四边形左下角的点。
-
第四个点是四边形右下角的点。
如果用户希望新四边形对注释的外观产生影响，请在设置四边形后 调用函数FoxitPDFSDKPython3.Annot.ResetAppearanceStream 。
- 参数
-
[in] quad_points_array 有效的四边形数组。它不应该是空数组。
- 返回
- 无。
